Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Clarify credential workflow for SSH target types #5082

Merged
merged 3 commits into from
Sep 11, 2024

Conversation

Dan-Heath
Copy link
Contributor

@Dan-Heath Dan-Heath commented Sep 6, 2024

The documentation is not clear about the requirement to use injected credentials for SSH target types. This has led to some confusion internally. This PR attempts to connect some dots between target type requirements and the credential brokering/injection workflows.

It contains the following updates:

  • In the Credential injection section of the Credential management concepts page, I changed "Credential injection is available..." to "Credential injection is required..."
  • In the End user workflows section of the credential management Overview topic, I added a 4th paragraph that explains that target type has an impact on the credential workflow you can configure.
  • In the Requirements section of the credential brokering configuration topic, I updated the first bullet to add "To use brokered credentials to connect to a target that runs SSH, you must use a TCP target type. I also added a More information section at the bottom of the topic.
  • In the Requirements section of the credential injection configuration topic, I updated the second bullet to add "To use injected application credentials to connect to a target that runs SSH, you must use an SSH target type. I also added a More information section at the bottom of the topic.

@Dan-Heath Dan-Heath self-assigned this Sep 6, 2024
@Dan-Heath Dan-Heath added this to the deferred milestone Sep 6, 2024
@Dan-Heath Dan-Heath added the backport/website Backport changes to `stable-website` and the latest release-branch label Sep 6, 2024
@Dan-Heath Dan-Heath marked this pull request as ready for review September 6, 2024 14:06
@Dan-Heath Dan-Heath requested a review from a team as a code owner September 6, 2024 14:06
@vanphan24
Copy link
Contributor

This looks great @Dan-Heath ! Approved!

Copy link
Contributor

@vanphan24 vanphan24 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks great Dan, thanks!

…gure-credential-injection.mdx

Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/website Backport changes to `stable-website` and the latest release-branch docs/concepts docs/configuration website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants